home *** CD-ROM | disk | FTP | other *** search
/ Especial Multimedia / Especial Multimedia.iso / Multimed / Prg / TBK-COMM.ZIP / TBK-COMM.TBK (.txt) < prev   
Asymetrix ToolBook File  |  1997-09-14  |  97KB  |  1,918 lines
  1. isComRxReady
  2. isComRxReady
  3. isComRxReady    
  4. TBK-COMM.DLL
  5. isComRxReady(<COM number>)
  6. Checks if there are characters in the receive buffer for a COM port.
  7. To declare this function, include the following statement in the linkDLL control structure:
  8. WORD isComRxReady(WORD)
  9. <COM number> is the number of the COM port you want to check, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  10. The number of bytes in the receive buffer.  If the receive buffer is empty, the number is 0.
  11. to handle idle
  12.     if isComRxReady(1) > 0 then 
  13.         put readComPort(1) after text of field "Input"
  14. exampleHilite
  15. isComTxReady
  16. isComTxReady
  17. isComTxReady    
  18. TBK-COMM.DLL
  19. isComTxReady(<COM number>)
  20. Checks if there is room in the transmit buffer for a COM port.  You can use this function to avoid long waits because writeComPort will loop as long as necessary to avoid overrunning the output buffer.
  21. To declare this function, include the following statement in the linkDLL control structure:
  22. WORD isComTxReady(WORD)
  23. <COM number> is the number of the COM port you want to check, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  24. The number of free bytes in the transmit buffer.  If the transmit buffer is empty, the number is the same as the size of the buffer.
  25. while isComTxReady(1) < 1 
  26.     if sysTime - MarkTime > 1 then
  27.         request "Time out error on COM 1"
  28.         break to system
  29. end while
  30. get writeComPort(1, TheText)
  31. exampleHilite
  32. openComPort
  33. TBK-COMM.DLL
  34. openComPort
  35. openComPort    
  36. TBK-COMM.DLL
  37. openComPort(<COM number>,<Input Buffer Size>,<Output Buffer Size>)
  38. Opens a serial port for communications.
  39. Caution:  You must call closeComPort before exiting your application, otherwise the port remains unavailable to other applications and will remain unavailable even after you exit Windows.
  40. To declare this function, include the following statement in the linkDLL control structure:
  41. INT openComPort(WORD,WORD,WORD)
  42. <COM number> is the number of the COM port you want to open, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  43. <Input Buffer Size> is the size of the input buffer the driver will reserve for this port.  If <Input Buffer Size> is 0, a default buffer size of 1024 bytes will be assumed.  Minimum buffer size is 32 characters; maximum i s 32767.
  44. <Output Buffer Size> is the size of the output buffer the driver will reserve for this port.  If <Output Buffer Size> is 0, a default buffer size of 128 bytes will be assumed.  Minimum buffer size is 32 characters; maximum i s 32767.
  45. A Windows device handle it successful, or a negative number if it failed
  46. The Windows device handle is not used by the other functions in this DLL, but it is returned in case you need to reference the port in calls to other functions.
  47. if openComPort(1,256,0) >= 0 then 
  48.     request "COM1 opened successfully"
  49.     request "Could not open COM1"
  50. end if
  51. exampleHilite
  52. setComPort
  53. readComPort
  54. readComPort    
  55. TBK-COMM.DLL
  56. readComPort(<COM number>)
  57. Reads the characters in the receive buffer for a COM port.  Note:  The received string will be truncated if it contains a character with a null value (ANSI character zero).
  58. To declare this function, include the following statement in the linkDLL control structure:
  59. STRING readComPort(WORD)
  60. <COM number> is the number of the COM port you want to check, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  61. A string of characters.  If the receive buffer was empty, a null string.
  62. set Echo to readComPort(1) 
  63. exampleHilite
  64. clearComBreak
  65. clearComBreak    
  66. TBK-COMM.DLL
  67. clearComBreak(<COM number>)
  68. Suspends character transmission and places the transmission line in a break state until the clearComBreak function is called.
  69. INT clearComBreak(WORD)
  70. <COM number> is the number of the COM port you want to set, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  71. 0 or a positive number if the function was successful
  72. A negative number if the port is not open or if there is an unspecified error.
  73. if get SetComBreak(PortNo) >= 0
  74.     pause 30 -- .3 seconds
  75.     get ClearComBreak(PortNo) 
  76. exampleHilite
  77. writeComPort
  78. setComBreak
  79. setComBreak    
  80. TBK-COMM.DLL
  81. setComBreak(<COM number>)
  82. Restores character transmission suspended by a call to setComBreak and places the transmission line in a nonbreak state.
  83. INT clearComBreak(WORD)
  84. <COM number> is the number of the COM port you want to set, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  85. 0 or a positive number if the function was successful
  86. A negative number if the port is not open or if there is an unspecified error.
  87. if get SetComBreak(PortNo) >= 0 
  88.     pause 30 -- .3 seconds
  89.     get ClearComBreak(PortNo)
  90. exampleHilite
  91. 8Z    \    \    
  92. TBK-COMM.DLL
  93. clearComBreak    Suspends character transmission and places the transmission line in a break state until the clearComBreak function is called.
  94. closeComPort    Closes the port designated by <COM number>.  If the port was not opened, the function has no effect.
  95. flushComRxBuffer    Flushes out any characters in the receive buffer for a COM port.  The characters are lost.
  96. flushComTxBuffer    Flushes out any characters in the transmit buffer for a COM port.  The characters are lost.
  97. isComRxReady    Checks if there are characters in the receive buffer for a COM port.
  98. isComTxReady    Checks if there is room in the transmit buffer for a COM port.  You can use this function to avoid long waits because writeComPort will loop as long as necessary to avoid overrunning the output buffer.
  99. openComPort    Opens a serial port for communications.
  100. readComPort    Reads the characters in the receive buffer for a COM port.  Note:  The received string will be truncated if it contains a character with a null value (ANSI character zero).
  101. setComBreak    Restores character transmission suspended by a call to setComBreak and places the transmission line in a nonbreak state.
  102. setComPort    Sets the parameters for a COM port.  The port must have been previously opened with openComPort.  SetComPort will also reset the port completely, if possible.
  103. setComPortTxXlate    Turns on or off the translation of transmitted escape character sequences for the specified port.  The port must be open.  By default, this setting is off when you open the port.  Since you cannot embed null characters in an OpenScript string, this allows you to embed escape sequences that will be transmitted as nulls.  Note that the second character in \0 is the digit zero, not an uppercase o.
  104. TBK_COMMVersion    Returns a string containing the name of the DLL, the version number and the date this version was compiled.
  105. writeComPort    Writes <output> to the transmit buffer of a COM port.  Note:  There is currently no way to transmit nulls.  This capability will be added in a future version.
  106. This DLL contains functions to control up to 4 serial ports and communicate through them.  
  107. What can the functions in TBK-COMM.DLL do?
  108. setComPort
  109. setComPort    
  110. TBK-COMM.DLL
  111. setComPort(<COM number>,<baud>,<byte size>,<stop bits>,<parity>,<handshake>)
  112. Sets the parameters for a COM port.  The port must have been previously opened with openComPort.  SetComPort will also reset the port completely, if possible.
  113. To declare this function, include the following statement in the linkDLL control structure:
  114. INT setComPort(WORD,WORD,WORD,WORD,WORD,WORD)
  115. <COM number> is the number of the COM port you want to set, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  116. <baud> is the baud rate; it can be any baud rate supported by Windows and the COM port hardware, typically 110, 300, 600, 1200, 2400, 4800, 9600 or 19200.
  117. <byte size> is the number of bits in each transmitted character, typically 7 or 8.
  118. <stop bits> is the number of stop bits that follow a transmitted character.
  119. <parity> is 0 for no parity, 1 for odd parity and 2 for even parity.
  120. <handshake> is 0 for no handshaking, 1 for hardware handshaking, or 2 for Xon/Xoff handshaking.  When hardware handshaking is used, RTS is used for transmit flow control and DTR is used for receive flow control.  Both are set to time out after 4 seconds.
  121. 0 or a positive number if the function was successful
  122. -1 if the port is not open or if there is an unspecified error.
  123. -202 if the <baud> rate is invalid
  124. -203 if the <byte size> parameter is invalid
  125. -204 if the <stop bits> parameter is invalid
  126. -205 if the <parity> parameter is invalid
  127. -206 if the <handshake> parameter is invalid
  128. get openComPort(1, 0, 0) -- Open COM1 with default buffer sizes
  129. if it >= 0 then
  130.     get setComPort(1, 9600, 8, 1, 0, 0) -- 9600 baud, no parity, no handshake 
  131. if it < 0 then
  132.     request "Could not open COM1"
  133. exampleHilite
  134. setComPortTxXlate
  135. exampleHilite
  136. setComPortTxXlate    
  137. TBK-COMM.DLL
  138. setComPortTxXlate(<COM number>,<on/off>)=
  139. Turns on or off the translation of transmitted escape character sequences for the specified port.  The port must be open.  By default, this setting is off when you open the port.  Since you cannot embed null characters in an OpenScript string, this allows you to embed escape sequences that will be transmitted as nulls.  Note that the second character in \0 is the digit zero, not an uppercase o.
  140. Supported escape sequewnces
  141. Character sequence    transmitted as    Hexadecimal equivalent
  142.     \0    null            00h
  143.     \a    bell (Alert)            07h
  144.     \b    backspace            08h
  145.     \f    form feed            0Eh
  146. To declare this function, include the following statement in the linkDLL control structure:
  147. INT setComPortTxXlate(WORD,WORD)
  148. <COM number> is the number of the COM port you want to set, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  149. <on/off> is 1 to turn the translation on, 0 to turn it off.  .
  150. 0 or a positive number if the function was successful
  151. A negative number if the port is not open or if there is an unspecified error.
  152. get openComPort(1, 0, 0) -- Open COM1 with default buffer sizes
  153. if it >= 0 then
  154.     get setComPort(1, 9600, 8, 1, 0, 0)    -- 9600 baud, no parity, no handshake
  155.     get setComPortTxXlate(1,1)         -- turn on translation of /0, etc. 
  156. if it < 0 then
  157.     request "Could not open COM1"
  158.     -- transmit  a few nulls
  159.     get writeComPort(1, "\0\0\0\0\0\0\0\0\0\0\0")
  160.     -- now transmit ssome normal characters, but make the other terminal beep too
  161.     get writeComPort(1, "Hello, anyone there?\a" & CRLF)
  162. his pa,.
  163. TBK_COMMVersion
  164. TBK_COMMVersion    
  165. TBK-COMM.DLL
  166. TBK_COMMVersion()
  167. Returns a string containing the name of the DLL, the version number and the date this version was compiled.
  168. STRING TBK_COMMVersion()
  169. None.
  170. A string in the form "TBK-COMM.DLL Version 1.0 4/1/90"
  171. TBK_COMMVersion    
  172. flushComTxBuffer
  173. writeComPort
  174. writeComPort    
  175. TBK-COMM.DLL
  176. writeComPort(<COM number>,<output>)
  177. Writes <output> to the transmit buffer of a COM port.  Note:  There is currently no way to transmit nulls.  This capability will be added in a future version.
  178. To declare this function, include the following statement in the linkDLL control structure:
  179. INT writeComPort(WORD, STRING)
  180. <COM number> is the number of the COM port you want to write to, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  181. <output> is anything that evaluates to a string.  If it has a numeric value, the string representation of that value is sent.
  182. The number of characters actually placed in the transmit queue.  If there was an error, the function returns a negative number.  Expect the following values:
  183. -1 if the port is not open or there is another unspecified error
  184. -16 if a break was detected
  185. -32 if a CTS time out was detected
  186. -64 if a DSR time out was detected
  187. - 256 if the transmit queue was full while trying to queue a character (internal DLL error).
  188. if writeComPort(1, "Hello there" & CR)  > 0 then 
  189.     request "It worked!"
  190. end if
  191. exampleHilite
  192. clearComBreak
  193. closeComPort
  194. setComPortTxXlate
  195. flushComRxBuffer
  196. TBK-COMM.DLL Reference                            page 
  197. Main List
  198. removeRecords    
  199. Main List
  200. copyFile
  201. displayAspectY
  202. lastDBRecord
  203. displayAspectXY
  204. DLL descriptions
  205. System
  206. s Rmn
  207. saveDate
  208. 60,87.625,100
  209. J     1990
  210. March 8, 1990
  211. defcolor
  212. TBK-COMM.DLL Reference
  213. L Help
  214. S:CONDITIONDATA
  215.     subtitle is "TBKWIN.DLL"
  216. (S:REPORTDATA
  217. Atrue
  218. AVBtrue
  219. AVBtrue
  220. AVBtrue
  221. AVBtrue
  222. text of recordfield "DLL" is in "TBKWIN.DLL"
  223. text of recordfield "DLL" is in "TBKWIN.DLL"
  224. text of recordfield "DLL" is in "TBKWIN.DLL"
  225. Intro Text
  226. Function List
  227. nelds
  228. which
  229. :PRINTLAYOUT
  230. false
  231. false
  232. false
  233. false
  234. false
  235. false
  236. false
  237. false
  238. false
  239. false
  240. false
  241. false
  242. false
  243. false
  244. false
  245. false
  246. false
  247. false
  248. false
  249. false
  250. March 27, 1990
  251. March 27, 1990
  252. Intro Text
  253. Function List
  254. "DLL" is in "TBKWIN.DLL"
  255. text of recordfield "DLL" is in "TBKWIN.DLL"
  256. text of recordfield "DLL" is in "TBKWIN.DLL"
  257. text of recordfield "DLL" is in "TBKWIN.DLL"
  258. text of recordfield "DLL" is in "TBKWIN.DLL"
  259. text of recordfield "DLL" is in "TBKFILE.DLL"
  260. text of recordfield "DLL" is in "TBKFILE.DLL"
  261. text of recordfield "DLL" is in "tbkfile"
  262. text of recordfield "DLL" is in "tbkfile"
  263. text of recordfield "DLL" is in "tbkfile.dll"
  264. text of recordfield "DLL" is in "tbkdb3.dll"
  265. text of recordfield "DLL" is in "tbkfile.dll"
  266. text of recordfield "DLL" is in "tbkwin.dll"
  267. text of recordfield "DLL" is in "tbkwin.dll"
  268. text of recordfield "DLL" is in "tbkwin.dll"
  269. text of recordfield "DLL" is in "tbkdb3.dll"
  270. text of recordfield "DLL" is in "tbkdb3.dll"
  271. _B|B|
  272. Parameters
  273. Returns
  274. Example
  275. n "tbkwin.dll"
  276. text of recordfield "DLL" is in "tbkwin.dll"
  277. text of recordfield "DLL" is in "tbkdb3.dll"
  278. text of recordfield "DLL" is in "tbkdb3.dll"
  279. text of recordfield "DLL" is in "tbkdb3.dll"
  280. text of recordfield "DLL" is in "tbkdb3.dll"
  281. text of recordfield "DLL" is in "tbkdb3.dll"
  282. text of recordfield "DLL" is in "tbkdb3.dll"
  283. wtrue
  284. Qtext of recordfield "DLL" is in "TBKDB3.DLL"
  285. Qtext of recordfield "DLL" is in "TBKDB3.DLL"
  286. Rtrue
  287. Strue
  288. Rxt of recordfield "DLL" is in "TBKDB3.DLL"
  289. PdefaultColor
  290. P0,100,0
  291. {300,50,100
  292. {0,50,100
  293. 0,75.6875,0
  294. P60,87.625,100
  295. March 9, 1990
  296. March 16, 1990
  297. March 16, 1990
  298. c"&Edit" 
  299. c"&Clipboard" 
  300. "Copy LinkDLL statement" 
  301. %Example" 
  302. deActivate 
  303. "CopyLinkDLLstatement" 
  304. "&Author" & 
  305. 9& "F3" 
  306. c"Help" 
  307. "About This Book..." 
  308. c"&Special" 
  309. "Print &
  310. 6Page" 
  311. Summary..." 
  312. =Function Encyclopedia..." 
  313. "Background Color..." 
  314. odefaultColor
  315. backgroundColor
  316. "Pick a fill color 
  317. tray."
  318. AboutThisBook
  319. 8:" & CRLF \
  320. & "ToolBook standard 
  321. function reference." & 
  322. & "Version 1.0 -"\
  323. && saveDate 
  324. setPrintDefaults
  325. 360,360
  326. 1440,1440,1440,1440
  327. PrintThisPage
  328. PrintFunctionEncyclopedia
  329. Pages"
  330. printDLLSummary
  331. PrintDLLSummary 
  332. descriptions"
  333. stamp
  334. SaveAs
  335. "M d, y"
  336. odefcolor 
  337. 4switchingLevels
  338. lockFields 
  339. Descriptions", 
  340. setAuthor
  341. which, how
  342. -- locks 
  343. unlocks 
  344. fields 
  345. a list 
  346. -- recursive 
  347. encountering a 
  348. that may contain 
  349. ClearBook
  350. will 
  351. contents 
  352. f"OK" 
  353. "Cancel"
  354. "OK" 
  355. "DLL"
  356. "Syntax"
  357. "Returns"
  358. "Parameters"
  359. List"
  360. "Subtitle"
  361. "Intro Text"
  362. "Main 
  363. trim s
  364. s <> 
  365. cs <> 
  366. < 32 
  367. s <> 
  368. cs <> 
  369. s) <= 32
  370. -- filter non-
  371. assorted funky 
  372. ", s)
  373. p > 0 
  374. cp > 0
  375. ", s)
  376. ", s) = 1
  377. Appending 
  378. "Are you sure 
  379. want 
  380. f"Yes" 
  381. showImportHelp
  382. ("Name 
  383. file (type 
  384. should appear 
  385. titles):"
  386. c"." 
  387. ~(".",
  388. ) - 1 
  389. ("File 
  390. ffN & ".TXT"
  391. sendaux(
  392. pcount 
  393. isTitle 
  394. isSyntax 
  395. isDescr 
  396. isTReturns 
  397. isParameters 
  398. isExample 
  399. WaitingForIntro 
  400. IntroTag 
  401. (165) & "_"
  402. NewPage
  403. theLine 
  404. leading LF
  405. a)) > 1
  406. SetDLLIntroTxt dfN, 
  407. <> "Examples" 
  408. update numbers 
  409. "ImportFListHelp"
  410. setDLLIntroTxt dllName, txt
  411. oldPg 
  412. "Do a complete 
  413. findExamples 
  414. ", \ 
  415. -- Update 
  416. front 
  417. "Sort 
  418. fList 
  419. "Done. 
  420. UpdateDLLPages 
  421. sysSuspendMessages 
  422. oldPage 
  423. dList 
  424. -- We now have a 
  425. functions 
  426. their 
  427. DLLList 
  428. dName 
  429. fName 
  430. "What can 
  431. " && 
  432. Lmax 
  433. cL = 0 
  434. j <= 
  435. L = 0 -- 
  436. "Adding" && 
  437. " && 
  438. 4s_searchString
  439. ("Search 
  440. selectedTextState 
  441. "Cannot 
  442. " && 
  443. & "."
  444. cyclopedia
  445. printDLLSummary
  446. enterbackground
  447. SaveAs
  448. stamp
  449. leaveBook
  450. first
  451. AboutThisBook
  452. previous
  453. printpages
  454. setPrintDefaults
  455. reader
  456. keydown
  457. enterBook
  458. setAuthor
  459. author
  460. PrintThisPage
  461. lockFields
  462. ClearBook
  463. backgroundColor
  464. import
  465. showImportHelp
  466. setDLLIntroTxt
  467. PrintFunctionEncyclopedia
  468. UpdateDLLPages
  469. search
  470. enterBook
  471. reader
  472. sizetopage
  473. newPage
  474. import
  475. &Edit
  476. &Clipboard
  477. Copy LinkDLL statement
  478. Clipboard
  479. Copy Example
  480. Clipboard
  481. CopyLinkDLLstatement
  482. Copy Example
  483. &Author
  484. About This Book...
  485. &Special
  486. Print &This Page
  487. Special
  488. Print &DLL Summary...
  489. Special
  490. Print &Function Encyclopedia...
  491. Special
  492. Special
  493. Background Color...
  494. Special
  495. defaultColor
  496. leaveBook
  497. backgroundColor
  498. Pick a fill color for the background from the color tray.
  499. defaultColor
  500. enterbackground
  501. defaultColor
  502. defaultColor
  503. AboutThisBook
  504. About this book:
  505. ToolBook standard DLL function reference.
  506. Version 1.0 -
  507. saveDate
  508. setPrintDefaults
  509. PrintThisPage
  510. setPrintDefaults
  511. PrintFunctionEncyclopedia
  512. oPrintFunctionEncyclopedia
  513. Function Pages
  514. printDLLSummary
  515. PrintDLLSummary
  516. DLL descriptions
  517. stamp
  518. SaveAs
  519. stamp
  520. stamp
  521. M d, y
  522. saveDate
  523. default
  524. first
  525. default
  526. previous
  527. default
  528. default
  529. printpages
  530. defcolor
  531. defcolor
  532. defcolor
  533. reader
  534. lockFields
  535. Function Pages
  536. lockFields
  537. DLL Descriptions
  538. default
  539. switchingLevels
  540. keydown
  541. setAuthor
  542. switchingLevels
  543. setAuthor
  544. lockFields
  545. Function Pages
  546. lockFields
  547. DLL Descriptions
  548. default
  549. switchingLevels
  550. author
  551. setAuthor
  552. lockFields
  553. field
  554. group
  555. lockFields
  556. which
  557. ClearBook
  558. This will clear the contents of all the pages in the book.
  559. Cancel
  560. Function Pages
  561. clear
  562. Function
  563. Syntax
  564. Description
  565. Returns
  566. Example
  567. Parameters
  568. DLL Descriptions
  569. clear
  570. Function List
  571. Subtitle
  572. Intro Text
  573. Main List
  574. Main List
  575. default
  576. import
  577. Function
  578. Function Pages
  579. Are you sure you want to import?
  580. Cancel
  581. showImportHelp
  582. Name of DLL file (type name as it should appear in titles):
  583. File to import:
  584. Function Pages
  585. end of file
  586. y5NewPage
  587. end of file
  588. SetDLLIntroTxt
  589. y5newPage
  590. Function
  591. Syntax
  592. Description
  593. Parameters
  594. Returns
  595. Example
  596. Function~
  597. title
  598. Syntax
  599. Description
  600. Parameters
  601. Returns
  602. Example
  603. Examples
  604. end of file
  605. y5newPage
  606. Function
  607. Syntax
  608. Description
  609. Parameters
  610. Returns
  611. Example
  612. enterbackground
  613. theLine
  614. IntroTag
  615. WaitingForIntro
  616. Example
  617. Parameters
  618. TReturns
  619. Descr
  620. Syntax
  621. Title
  622. isExample
  623. isParameters
  624. isTReturns
  625. isDescr
  626. isSyntax
  627. isTitle
  628. pcount
  629. default
  630. count
  631. Appending
  632.  /    TH'    i
  633. showImportHelp
  634. ImportFListHelp
  635. setDLLIntroTxt
  636. DLL Descriptions
  637. y5newPage
  638. Intro text
  639. oldPg
  640. dllName
  641. DLL Descriptions
  642. Do a complete sort and update of the book?
  643. Function Pages
  644. enterbackground
  645. findExamples
  646. Function
  647. Sort complete. Update Main Function List?
  648. Function
  649. Main List
  650. Main List
  651. Done. Update DLL Description Pages?
  652. kUpdateDLLPages
  653. default
  654. fList
  655. UpdateDLLPages
  656. DLL descriptions
  657. DLL descriptions
  658. DLLList
  659. DLLList
  660. DLL descriptions
  661. y5newPage
  662. What can the functions in
  663. Function list
  664. Adding
  665. to page
  666. Description
  667. Function list
  668. fName
  669. dName
  670. dList
  671. oldPage
  672. fList
  673. search
  674. Search for:
  675. Cancel
  676. Cannot find
  677. s_searchString
  678. 60,87.625,100
  679. ldPage
  680. fList
  681. search
  682. Search for:
  683. Cancel
  684. Cannot find
  685. s_searchString
  686. Qtext of recordfield "DLL" is in "TBKDB3.DLL"
  687. Rtext of recordfield "DLL" is in "TBKDB3.DLL"
  688. Rtrue
  689.  Rtrue
  690. Rtrue
  691. Intro Text
  692. Function List
  693. -- 3/27/90 Claude O.
  694. c"&Edit" 
  695. c"&Clipboard" 
  696. "Copy &LinkDLL Statement" 
  697. &All 
  698. &s For This 
  699. MExample" 
  700. deActivate 
  701. "CopyLinkDLLstatement" 
  702. "CopyAllLinkDLLStatementsForThisDLL" 
  703. "&Author" & 
  704. 9& "F3" 
  705. c"Help" 
  706. "About 
  707. Book..." 
  708. c"&Special" 
  709. "Print &
  710. Page" 
  711. ummary..." 
  712. =Function Encyclopedia..." 
  713. "Background Color..." 
  714. odefaultColor
  715. backgroundColor
  716. "Pick a fill color 
  717. tray."
  718. AboutThisBook
  719. 8:" & CRLF \
  720. & "Version 1.0 -"\
  721. && saveDate 
  722. setPrintDefaults
  723. 360,360
  724. 1440,1440,1440,1440
  725. PrintThisPage
  726. PrintFunctionEncyclopedia
  727. Pages"
  728. printDLLSummary
  729. PrintDLLSummary 
  730. descriptions"
  731. CopyAllStatements 
  732. stamp
  733. SaveAs
  734. "M d, y"
  735. odefcolor 
  736. 4switchingLevels
  737. lockFields 
  738. Descriptions", 
  739. setAuthor
  740. which, how
  741. -- locks 
  742. unlocks 
  743. fields 
  744. a list 
  745. -- recursive 
  746. encountering a 
  747. that may contain 
  748. ClearBook
  749. will 
  750. contents 
  751. f"OK" 
  752. "Cancel"
  753. "OK" 
  754. "Syntax"
  755. "Returns"
  756. "Parameters"
  757. List"
  758. "Subtitle"
  759. "Intro Text"
  760. "Main 
  761. trim s
  762. s <> 
  763. cs <> 
  764. < 32 
  765. s <> 
  766. cs <> 
  767. s) <= 32
  768. -- filter non-
  769. assorted funky 
  770. ", s)
  771. p > 0 
  772. cp > 0
  773. ", s)
  774. ", s) = 1
  775. Appending 
  776. "Are you sure 
  777. want 
  778. f"Yes" 
  779. showImportHelp
  780. ("Name 
  781. file (type 
  782. should appear 
  783. titles):"
  784. c"." 
  785. ~(".",
  786. ) - 1 
  787. ("File 
  788. ffN & ".TXT"
  789. sendaux(
  790. pcount 
  791. isTitle 
  792. isSyntax 
  793. isDescr 
  794. isTReturns 
  795. isParameters 
  796. isExample 
  797. WaitingForIntro 
  798. IntroTag 
  799. (165) & "_"
  800. NewPage
  801. theLine 
  802. leading LF
  803. a)) > 1
  804. SetDLLIntroTxt dfN, 
  805. <> "Examples" 
  806. update numbers 
  807. "ImportFListHelp"
  808. setDLLIntroTxt dllName, txt
  809. oldPg 
  810. "Do a complete 
  811. findExamples 
  812. ", \ 
  813. -- Update 
  814. front 
  815. "Sort 
  816. fList 
  817. "Done. 
  818. UpdateDLLPages 
  819. sysSuspendMessages 
  820. oldPage 
  821. dList 
  822. -- We now have a 
  823. functions 
  824. their 
  825. DLLList 
  826. dName 
  827. fName 
  828. "What can 
  829. " && 
  830. Lmax 
  831. cL = 0 
  832. j <= 
  833. L = 0 -- 
  834. "Adding" && 
  835. " && 
  836. 4s_searchString
  837. ("Search 
  838. selectedTextState 
  839. "Cannot 
  840. " && 
  841. & "."
  842. printDLLSummary
  843. CopyAllLinkDLLStatementsForThisDLL
  844. enterbackground
  845. SaveAs
  846. stamp
  847. leaveBook
  848. AboutThisBook
  849. first
  850. previous
  851. setPrintDefaults
  852. printpages
  853. reader
  854. enterBook
  855. keydown
  856. setAuthor
  857. PrintThisPage
  858. author
  859. lockFields
  860. backgroundColor
  861. ClearBook
  862. import
  863. showImportHelp
  864. PrintFunctionEncyclopedia
  865. setDLLIntroTxt
  866. UpdateDLLPages
  867. search
  868. enterBook
  869. reader
  870. sizetopage
  871. newPage
  872. import
  873. &Edit
  874. &Clipboard
  875. Copy &LinkDLL Statement
  876. Clipboard
  877. Copy &All LinkDLL Statements For This DLL
  878. Clipboard
  879. Copy &Example
  880. Clipboard
  881. CopyLinkDLLstatement
  882. CopyAllLinkDLLStatementsForThisDLL
  883. Copy Example
  884. &Author
  885. About This Book...
  886. &Special
  887. Print &This Page
  888. Special
  889. Print &DLL Summary...
  890. Special
  891. Print &Function Encyclopedia...
  892. Special
  893. Special
  894. Background Color...
  895. Special
  896. defaultColor
  897. leaveBook
  898. backgroundColor
  899. Pick a fill color for the background from the color tray.
  900. defaultColor
  901. defaultColor
  902. enterbackground
  903. defaultColor
  904. defaultColor
  905. AboutThisBook
  906. About this book:
  907. Version 1.0 -
  908. saveDate
  909. setPrintDefaults
  910. PrintThisPage
  911. setPrintDefaults
  912. PrintFunctionEncyclopedia
  913. oPrintFunctionEncyclopedia
  914. Function Pages
  915. printDLLSummary
  916. PrintDLLSummary
  917. DLL descriptions
  918. CopyAllLinkDLLStatementsForThisDLL
  919. CopyAllStatements
  920. Function Pages
  921. stamp
  922. SaveAs
  923. stamp
  924. stamp
  925. M d, y
  926. saveDate
  927. default
  928. first
  929. default
  930. previous
  931. default
  932. default
  933. printpages
  934. defcolor
  935. defcolor
  936. defcolor
  937. reader
  938. lockFields
  939. Function Pages
  940. lockFields
  941. DLL Descriptions
  942. default
  943. switchingLevels
  944. keydown
  945. setAuthor
  946. switchingLevels
  947. setAuthor
  948. lockFields
  949. Function Pages
  950. lockFields
  951. DLL Descriptions
  952. default
  953. switchingLevels
  954. author
  955. setAuthor
  956. lockFields
  957. field
  958. group
  959. lockFields
  960. which
  961. ClearBook
  962. This will clear the contents of all the pages in the book.
  963. Cancel
  964. Function Pages
  965. clear
  966. Function
  967. Syntax
  968. Description
  969. Returns
  970. Example
  971. Parameters
  972. DLL Descriptions
  973. clear
  974. Function List
  975. Subtitle
  976. Intro Text
  977. Main List
  978. Main List
  979. default
  980. import
  981. Function
  982. Function Pages
  983. Are you sure you want to import?
  984. Cancel
  985. showImportHelp
  986. Name of DLL file (type name as it should appear in titles):
  987. File to import:
  988. Function Pages
  989. end of file
  990. y5NewPage
  991. end of file
  992. SetDLLIntroTxt
  993. y5newPage
  994. Function
  995. Syntax
  996. Description
  997. Parameters
  998. Returns
  999. Example
  1000. Function~
  1001. title
  1002. Syntax
  1003. Description
  1004. Parameters
  1005. Returns
  1006. Example
  1007. Examples
  1008. end of file
  1009. y5newPage
  1010. Function
  1011. Syntax
  1012. Description
  1013. Parameters
  1014. Returns
  1015. Example
  1016. enterbackground
  1017. theLine
  1018. IntroTag
  1019. WaitingForIntro
  1020. Example
  1021. Parameters
  1022. TReturns
  1023. Descr
  1024. Syntax
  1025. Title
  1026. isExample
  1027. isParameters
  1028. isTReturns
  1029. isDescr
  1030. isSyntax
  1031. isTitle
  1032. pcount
  1033. default
  1034. count
  1035. Appending
  1036.  /    TH'    i
  1037. showImportHelp
  1038. ImportFListHelp
  1039. setDLLIntroTxt
  1040. DLL Descriptions
  1041. y5newPage
  1042. Intro text
  1043. oldPg
  1044. dllName
  1045. DLL Descriptions
  1046. Do a complete sort and update of the book?
  1047. Function Pages
  1048. enterbackground
  1049. findExamples
  1050. Function
  1051. Sort complete. Update Main Function List?
  1052. Function
  1053. Main List
  1054. Main List
  1055. Done. Update DLL Description Pages?
  1056. kUpdateDLLPages
  1057. default
  1058. fList
  1059. UpdateDLLPages
  1060. DLL descriptions
  1061. DLL descriptions
  1062. DLLList
  1063. DLLList
  1064. DLL descriptions
  1065. y5newPage
  1066. What can the functions in
  1067. Function list
  1068. Adding
  1069. to page
  1070. Description
  1071. Function list
  1072. fName
  1073. dName
  1074. dList
  1075. oldPage
  1076. fList
  1077. search
  1078. Search for:
  1079. Cancel
  1080. Cannot find
  1081. s_searchString
  1082. Function Pages
  1083. setPrintDefaults
  1084. odefPrinterFields
  1085. odefPrinterFieldWidths
  1086. PrintFunctionEncyclopedia
  1087. oldp 
  1088. 5 Pages"
  1089. functions, 
  1090. only those 
  1091. specific DLL(s)?" \
  1092. f"All" 
  1093. "Some" 
  1094. "Cancel"
  1095. printIt
  1096.  summary 
  1097. which 
  1098. `& CRLF\
  1099. & "Example: TBKWIN.
  1100. }, TBKFILE.
  1101. fDLLList 
  1102. ) > 1
  1103. c".")
  1104. & ".dll"
  1105. x(trim(
  1106. ) = 1
  1107. x("." 
  1108. Cancelled 
  1109. "does 
  1110. xmatch the DLLs described 
  1111. " &&\
  1112. E" & 
  1113. " && 
  1114. printreport
  1115. ofirstP 
  1116. olastP 
  1117. "CopyLinkDLLstatement" 
  1118. "CopyAllLinkDLLStatementsForThisDLL" 
  1119. deActivate 
  1120. _nt" 
  1121. "CopyExample" 
  1122. CopyLinkDLLStatement
  1123. "dummy" 
  1124. " & \
  1125. "Description" & 
  1126. CopyAllStatements
  1127. X" && 
  1128. s0 & 
  1129. X" & 
  1130. default
  1131. B"Previous" 
  1132. B"Next" 
  1133. fixScroll 
  1134. "Syntax"
  1135. "Parameters"
  1136. "Returns"
  1137. resetFieldSizes
  1138. "Help" 
  1139. x > 0 
  1140. expandSyntax
  1141. 1425,870,8610,5490
  1142. oexpSyntax 
  1143. expandDescription
  1144. 1425,870,8610,5490
  1145. oexpDescription 
  1146. expandParameters
  1147. 1425,870,8610,5490
  1148. oexpParameters 
  1149. expandReturns
  1150. 1425,870,8610,5490
  1151. oexpReturns 
  1152. 1425,870,8610,1525
  1153. 1425,1565,8610,3075
  1154. 1425,3105,8610,4350
  1155. 1425,4385,8610,5510
  1156. findExamples
  1157. srch 
  1158. Lmax 
  1159. cL = 0 
  1160. i <= LMax
  1161. <> "-"
  1162. <> " "
  1163. "example" 
  1164. & " "
  1165. L > 0 
  1166. exampleHilite 
  1167. CopyLinkDLLStatement
  1168. PrintFunctionEncyclopedia
  1169. CopyAllStatements
  1170. CopyExample
  1171. enterPage
  1172. leavePage
  1173. fixScroll
  1174. printIt
  1175. setPrintDefaults
  1176. previous
  1177. author
  1178. expandSyntax
  1179. enterbackground
  1180. expandDescription
  1181. expandParameters
  1182. leaveBackground
  1183. expandReturns
  1184. resetFieldSizes
  1185. findExamples
  1186. setPrintDefaults
  1187. defPrinterFields
  1188. defPrinterFieldWidths
  1189. PrintFunctionEncyclopedia
  1190. Function Pages
  1191. setPrintDefaults
  1192. Print all functions, or only those of specific DLL(s)?
  1193. Cancel
  1194. JRprintIt
  1195. Print summary for which DLL(s)?
  1196. Example: TBKWIN.DLL, TBKFILE.DLL
  1197. DLLList
  1198. DLLList
  1199. DLLList
  1200. Cancel
  1201. Cancel
  1202. does not match the DLLs described in this book:
  1203. DLLList
  1204. text of recordfield
  1205. is in
  1206. JRprintIt
  1207. Cancelled
  1208. i:to3
  1209. printIt
  1210. enterbackground
  1211. firstP
  1212. lastP
  1213. CopyLinkDLLstatement
  1214. CopyAllLinkDLLStatementsForThisDLL
  1215. leaveBackground
  1216. CopyLinkDLLstatement
  1217. CopyExample
  1218. CopyAllLinkDLLStatementsForThisDLL
  1219. CopyLinkDLLStatement
  1220. dummy
  1221. Description
  1222. dummy
  1223. CopyAllStatements
  1224. linkdll
  1225. Function Pages
  1226. Function Pages
  1227. Description
  1228. Function Pages
  1229. end linkdll
  1230. dummy
  1231. dummy
  1232. dummy
  1233. default
  1234. CopyExample
  1235. dummy
  1236. Example
  1237. dummy
  1238. enterPage
  1239. Example
  1240. Example
  1241. Example
  1242. CopyExample
  1243. CopyExample
  1244. Previous
  1245. firstP
  1246. lastP
  1247. fixScroll
  1248. Syntax
  1249. fixScroll
  1250. Description
  1251. fixScroll
  1252. Parameters
  1253. fixScroll
  1254. Returns
  1255. leavePage
  1256. resetFieldSizes
  1257. Example
  1258. Example
  1259. fixScroll
  1260. previous
  1261. author
  1262. Example
  1263. expandSyntax
  1264. Description
  1265. Parameters
  1266. Returns
  1267. Syntax
  1268. expSyntax
  1269. expandDescription
  1270. Syntax
  1271. Parameters
  1272. Returns
  1273. Description
  1274. expDescription
  1275. expandParameters
  1276. Syntax
  1277. Description
  1278. Returns
  1279. Parameters
  1280. expParameters
  1281. expandReturns
  1282. Syntax
  1283. Description
  1284. Parameters
  1285. Returns
  1286. expReturns
  1287. resetFieldSizes
  1288. expSyntax
  1289. expDescription
  1290. expParameters
  1291. expReturns
  1292. Syntax
  1293. Description
  1294. Parameters
  1295. Returns
  1296. Syntax
  1297. Description
  1298. Parameters
  1299. Returns
  1300. Syntax
  1301. Description
  1302. Parameters
  1303. Returns
  1304. expSyntax
  1305. expDescription
  1306. expParameters
  1307. expReturns
  1308. findExamples
  1309. Example
  1310. Function
  1311. example
  1312. exampleHilite
  1313.  0"p"
  1314. "4#z#
  1315. )z*&+
  1316. defPrinterFieldWidths
  1317. 7380,7380,7380,7380,7380,7380,7380
  1318. defPrinterFields
  1319. Function,DLL,Syntax,Description,Parameters,Returns,Example
  1320. 8expReturns
  1321. expParameters
  1322. false
  1323. expDescription
  1324. false
  1325. expSyntax
  1326. false
  1327. trim()
  1328. ?    setDrive
  1329. 8lastP
  1330. firstP
  1331. expDescription 
  1332. resetFieldSizes
  1333. expandDescription
  1334. buttonUp
  1335. buttonUp
  1336. expDescription
  1337. resetFieldSizes
  1338. expandDescription
  1339. Description
  1340. Description
  1341. expDescription 
  1342. resetFieldSizes
  1343. expandDescription
  1344. default
  1345. buttonUp
  1346. buttonUp
  1347. expDescription
  1348. resetFieldSizes
  1349. expandDescription
  1350. default
  1351. dummy
  1352. Function
  1353. Syntax
  1354. Description
  1355. Parameters
  1356. Returns
  1357. Syntax
  1358. Parameters
  1359. Returns
  1360. buttonUp
  1361. buttonUp
  1362. Go Back
  1363. Example
  1364. "Example" 
  1365. exampleHilite 
  1366. buttonUp
  1367. buttonUp
  1368. Example
  1369. exampleHilite
  1370. exampleHilite
  1371. Example
  1372. Example
  1373. Example
  1374. Example
  1375. 4s_interest
  1376. "DLL")
  1377. default
  1378. buttonUp
  1379. buttonUp
  1380. default
  1381. s_interest
  1382. Function List For This DLL
  1383. 4s_interest
  1384. buttonUp
  1385. buttonUp
  1386. first
  1387. s_interest
  1388. Main List
  1389. Previous
  1390. buttonUp
  1391. buttonUp
  1392. previous
  1393. buttonUp
  1394. buttonUp
  1395. Returns
  1396. )('';
  1397. expReturns 
  1398. resetFieldSizes
  1399. expandReturns
  1400. default
  1401. buttonUp
  1402. buttonUp
  1403. expReturns
  1404. resetFieldSizes
  1405. fexpandReturns
  1406. default
  1407. Parameters
  1408. expParameters 
  1409. resetFieldSizes
  1410. expandParameters
  1411. default
  1412. buttonUp
  1413. buttonUp
  1414. expParameters
  1415. resetFieldSizes
  1416. expandParameters
  1417. default
  1418. "Help" 
  1419. buttonUp
  1420. buttonUp
  1421. Example
  1422. buttonUp
  1423. buttonUp
  1424. Example
  1425. Example
  1426. buttonUp
  1427. buttonUp
  1428. Example
  1429. How to use the DLL Help function description pages:
  1430.     Use the arrow buttons to navigate from function to function in alphabetical order.
  1431.     Click Example to see one or more examples of usage of the function.  The Example button remains hidden if there is no example.
  1432.     If there is more text in a field than you can read comfortably, click the name of the field to expand it.  When a field is expanded, its name is highlighted.  Click the field name again to return it to its normal size, or click another field name to expand that other field.  Field sizes are reset automatically when you go to another page.
  1433.     Click Main List for the list of all functions, or Function List For This DLL for a list of all the functions that are available in the same DLL as the function described on this page. The function list for the DLL also contains a short description of the DLL organization and usage.
  1434.   Use the command "Copy LinkDLL Statement" in the edit menu to copy the linkDLL statement for the function on this page onto the clipboard.  You will then be able to paste it into a ToolBook script and avoid retyping errors.
  1435. Syntax
  1436. expSyntax 
  1437. resetFieldSizes
  1438. expandSyntax
  1439. default
  1440. buttonUp
  1441. buttonUp
  1442. expSyntax
  1443. resetFieldSizes
  1444. 9expandSyntax
  1445. default
  1446. false
  1447. closeComPort
  1448. closeComPort    
  1449. TBK-COMM.DLL
  1450. closeComPort(<COM number>)
  1451. Closes the port designated by <COM number>.  If the port was not opened, the function has no effect.
  1452. To declare this function, include the following statement in the linkDLL control structure:
  1453. INT closeComPort(WORD)
  1454. <COM number> is the number of a COM port.
  1455. If no error occurs, the function returns a positive number.  If there was an error, it returns 0.
  1456. get closeComPort(1) -- Close COM1 
  1457. exampleHilite
  1458. DLL descriptions
  1459. rectory
  1460. ofirstP 
  1461. olastP 
  1462. "CopyAllLinkDLLStatementsForThisDLL" 
  1463. deActivate 
  1464. "Help" 
  1465. setPrintDefaults
  1466. odefPrinterFields
  1467. odefPrinterFieldWidths
  1468. PrintDLLSummary
  1469. oldp 
  1470.  descriptions"
  1471.  summary 
  1472. DLLs, 
  1473. specific 
  1474. l(s)?" \
  1475. f"All" 
  1476. "Some" 
  1477. "Cancel"
  1478. printIt
  1479. which 
  1480. (s)?" & CRLF\
  1481. & "Example: TBKWIN.
  1482. , TBKFILE.
  1483. fDLLList 
  1484. ) > 1
  1485. c".")
  1486. & ".dll"
  1487. x(trim(
  1488. ) = 1
  1489. x("." 
  1490. Cancelled 
  1491. "does 
  1492. xmatch the 
  1493.  described 
  1494. " &&\
  1495. " && 
  1496. printreport -- 
  1497. Xsettings
  1498. /"DLL 
  1499. 4s_interest
  1500. "Function 
  1501. L > 0 
  1502. znothing
  1503. {Info" 
  1504. default
  1505. B"Previous" 
  1506. B"Next" 
  1507. Lmax 
  1508. cL = 0 
  1509. i <= LMax
  1510. L > 0 
  1511. "Intro 
  1512. Pages"
  1513. enterbackground
  1514. setPrintDefaults
  1515. PrintDLLSummary
  1516. printIt
  1517. leaveBackground
  1518. buttonDown
  1519. buttonDoubleClick
  1520. enterpage
  1521. leavePage
  1522. import
  1523. enterbackground
  1524. firstP
  1525. lastP
  1526. CopyAllLinkDLLStatementsForThisDLL
  1527. leaveBackground
  1528. CopyAllLinkDLLStatementsForThisDLL
  1529. leavePage
  1530. setPrintDefaults
  1531. defPrinterFields
  1532. defPrinterFieldWidths
  1533. PrintDLLSummary
  1534. DLL descriptions
  1535. setPrintDefaults
  1536. Print summary for all DLLs, or for specific DLL(s)?
  1537. Cancel
  1538. JRprintIt
  1539. Print summary for which DLL(s)?
  1540. Example: TBKWIN.DLL, TBKFILE.DLL
  1541. DLLList
  1542. DLLList
  1543. DLLList
  1544. Cancel
  1545. Cancel
  1546. does not match the DLLs described in this book:
  1547. DLLList
  1548. text of recordfield
  1549. is in
  1550. JRprintIt
  1551. Cancelled
  1552. i:to3
  1553. printIt
  1554. DLL descriptions
  1555. buttonDown
  1556. Function List
  1557. textFromPoint
  1558. button
  1559. Function Info
  1560. s_interest
  1561. buttonDoubleClick
  1562. buttonUp
  1563. Function Info
  1564. s_interest
  1565. enterpage
  1566. Function Info
  1567. Previous
  1568. firstP
  1569. lastP
  1570. Function List
  1571. Function List
  1572. Intro text
  1573. default
  1574. s_interest
  1575. import
  1576. Function Pages
  1577. !import
  1578. defPrinterFieldWidths
  1579. 9315,9315,9315
  1580. defPrinterFields
  1581. DLL,Intro Text,Function List
  1582. lastP
  1583. firstP
  1584. dummy
  1585. Function:    Summary::
  1586. Function Info
  1587. -- assumes that 
  1588. will only be able 
  1589. -- the function list 
  1590. Hclicking 
  1591. 4s_interest
  1592.      <> 
  1593. default
  1594. buttonUp
  1595. buttonUp
  1596. default
  1597. s_interest
  1598. Info on Selected Function
  1599. "Help" 
  1600. buttonUp
  1601. buttonUp
  1602. Intro Text
  1603. Function List
  1604. Subtitle
  1605. buttonUp
  1606. buttonUp
  1607. Go Back
  1608. buttonUp
  1609. buttonUp
  1610. first
  1611. Main List
  1612. Previous
  1613. buttonUp
  1614. buttonUp
  1615. previous
  1616. buttonUp
  1617. buttonUp
  1618. Function info
  1619. buttonUp
  1620. buttonUp
  1621. Example
  1622. How to use the DLL Description pages
  1623.     Use the arrow buttons to navigate from DLL to DLL in alphabetical order.
  1624.     Click Main List for the list of all functions, or click a function name then Info on Selected Function to go to the details page for that function.  You can also double-click a function name for the same result.
  1625. Using DLL functions
  1626.    Before you can call the functions in a DLL from a script, you must first link the DLL to ToolBook and declare the functions you want to use with the linkDLL control structure. 
  1627.    For details, see Appendix B, "Using DLLs with ToolBook," in the Using OpenScript manual.eset automatically when you go to another page.
  1628. .  Field sizes are reset automatically when you go to another page.
  1629. on described on this page. The function list for the DLL also contains a short description of the DLL organization and usage.
  1630.      usage.
  1631.      and usage.
  1632. TBK_COMMVersion
  1633. Function Pages
  1634. flushComRxBuffer
  1635. flushComRxBuffer    
  1636. TBK-COMM.DLL
  1637. flushComRxBuffer(<COM number>)
  1638. Flushes out any characters in the receive buffer for a COM port.  The characters are lost.
  1639. To declare this function, include the following statement in the linkDLL control structure:
  1640. INT flushComRxBuffer(WORD)
  1641. <COM number> is the number of the COM port you want to check, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  1642. 0 if failed, a positive number if successful.
  1643. get flushComRxBuffer(1) -- Flush receive queue of COM1 
  1644. exampleHilite
  1645. Main List
  1646. z) > 1
  1647. "PrintThisPage"
  1648. x <> 
  1649. 4s_interest
  1650. "Main List"
  1651. L > 0 
  1652. -- ignore
  1653. "DLL Info" 
  1654. "Function 
  1655. Lmax 
  1656. cL = 0 
  1657. i <= LMax
  1658. L > 0 
  1659. default
  1660. Pages"
  1661. ebackground
  1662. keydown
  1663. enterbackground
  1664. buttonDown
  1665. buttonDoubleClick
  1666. enterpage
  1667. leavebackground
  1668. import
  1669. enterbackground
  1670. go back
  1671. PrintThisPage
  1672. leavebackground
  1673. Print This Page
  1674. keydown
  1675. buttonDown
  1676. Main List
  1677. textFromPoint
  1678. button
  1679. field
  1680. DLL Info
  1681. Function Info
  1682. s_interest
  1683. buttonDoubleClick
  1684. buttonUp
  1685. Function Info
  1686. s_interest
  1687. enterpage
  1688. Main List
  1689. Main List
  1690. DLL Info
  1691. Function Info
  1692. default
  1693. s_interest
  1694. import
  1695. Function Pages
  1696. !import
  1697. go back
  1698. buttonUp
  1699. buttonUp
  1700. Go Back
  1701. Main List
  1702. Main List
  1703. clearComBreak    TBK-COMM.DLL
  1704. closeComPort    TBK-COMM.DLL
  1705. flushComRxBuffer    TBK-COMM.DLL
  1706. flushComTxBuffer    TBK-COMM.DLL
  1707. isComRxReady    TBK-COMM.DLL
  1708. isComTxReady    TBK-COMM.DLL
  1709. openComPort    TBK-COMM.DLL
  1710. readComPort    TBK-COMM.DLL
  1711. setComBreak    TBK-COMM.DLL
  1712. setComPort    TBK-COMM.DLL
  1713. setComPortTxXlate    TBK-COMM.DLL
  1714. TBK_COMMVersion    TBK-COMM.DLL
  1715. writeComPort    TBK-COMM.DLL
  1716. This book documents the functions contained in the file TBK-COMM.DLL.  Use at your own risk.made as to the
  1717. Serial Port DLL Function Reference
  1718. 4s_interest
  1719. buttonUp
  1720. buttonUp
  1721. s_interest
  1722. Info on Selected DLL
  1723. Function Info
  1724. 4s_interest
  1725. buttonUp
  1726. buttonUp
  1727. s_interest
  1728. Info on Selected Function
  1729. "help"
  1730. buttonUp
  1731. buttonUp
  1732. Version
  1733.  Copyright 
  1734.  Asymetrix Corporation 1989, 1990 -- Version 1.0
  1735. /"function 
  1736. buttonUp
  1737. buttonUp
  1738. function pages
  1739. Browse All Functions
  1740. DLL info
  1741. Function info
  1742. )18\4
  1743. /"DLL Descriptions"
  1744. buttonUp
  1745. buttonUp
  1746. DLL Descriptions
  1747. Browse DLL Descriptions
  1748. buttonUp
  1749. buttonUp
  1750. To use this book:
  1751. Click on the name of a function to select it, then click one of the buttons on the right for details about the function or details about the DLL in which it is available.  You can also double-click a function name to go to that function directly.
  1752. To use DLL functions:
  1753. You must have "linked in" the function before you can call it in your script.  To link in a function, use a statement in the following form:
  1754.     linkDLL <DLL file name>
  1755.         <return type> <function name>(<parameter1>, <parameter 2>....)
  1756.     end linkDLL
  1757. Example:
  1758.     linkDLL "TBKFILE.DLL"
  1759.         INT fileExists(STRING)
  1760.     end linkDLL
  1761. If you make any mistake in the linkDLL statement, it may lead to a system crash when the function is called.  For more information, see the OpenScript documentation.  You can use the Copy LinkDLL Statement command in the Clipboard menu to save typing time and avoid errors.
  1762. setComBreak
  1763.   Importing into the "Function by function" background
  1764. Import is from an ASCII file, where records and fields are identified by a specific tag at the beginning of the line:
  1765. "?" for function name
  1766.  "!" for syntax
  1767. "#" for description
  1768. ";" for parameters
  1769. ":" for what the function returns
  1770. "$" for example
  1771. Each of the above "fields" can contain empty lines and line breaks.
  1772. The tag can be inserted as "invisible" style characters in a Microsoft word file.  The easiest way to do this is to make them glossary entries and insert it into the file.
  1773. Sorting must be done manually after the import is complete.  Be sure to check the "Example" field of the last imported field for garbage before you sort.
  1774. C.O. 12/14/89null then
  1775.                 set Title to theLine
  1776.             else
  1777.                 set Title to Title & CRLF & theLine
  1778.             end if
  1779.         end if
  1780.         if isSyntax and theLine <> "Syntax"
  1781.             if Syntax is null then
  1782.                 set Syntax to theLine
  1783.             else
  1784.                 set Syntax to Syntax & CRLF & theLine
  1785.             end if
  1786.         end if
  1787.         if isDescr and theLine <> "Description"
  1788.             if Descr is null then
  1789.                 set Descr to theLine
  1790.             else
  1791.                 set Descr to Descr & CRLF & theLine
  1792.             end if
  1793.         end if
  1794.         if isParameters and theLine <> "Parameters" then
  1795.             if Parameters is null then
  1796.                 set Parameters to theLine
  1797.             else
  1798.                 set Parameters to Parameters & CRLF & theLine
  1799.             end if
  1800.         end if
  1801.         if isTReturns and theLine <> "Returns" then
  1802.             if TReturns is null then
  1803.                 set TReturns to theLine
  1804.             else
  1805.                 set TReturns to TReturns & CRLF & theLine
  1806.             end if
  1807.         end if
  1808.         if isExample and theLine <> "Example" and \
  1809.             theLine <> "Examples" then
  1810.             if Example is null then
  1811.                 set Example to theLine
  1812.             else
  1813.                 set Example to Example & CRLF & theLine
  1814.             end if
  1815.         end if
  1816. Parameters is null then
  1817.                 set Parameters to theLine
  1818.             else
  1819.                 set Parameters to Parameters & CRLF & theLine
  1820.             end if
  1821.         end if
  1822.         if isTReturns and theLine <> "Returns" then
  1823.             if TReturns is null then
  1824.                 set TReturns to theLine
  1825.             else
  1826.                 set TReturns to TReturns & CRLF & theLine
  1827.             end if
  1828.         end if
  1829.         if isExample and theLine <> "Example" and \
  1830.             theLine <> "Examples" then
  1831.             if Example is null then
  1832.                 set Example to theLine
  1833.             else
  1834.                 set Example to Example & CRLF & theLine
  1835.             end if
  1836.         end if
  1837.      end if
  1838.         end if
  1839.         if isParameters and theLine <> "Parameters" then
  1840.             if Parameters is null then
  1841.                 set Parameters to theLine
  1842.             else
  1843.                 set Parameters to Parameters & CRLF & theLine
  1844.             end if
  1845.         end if
  1846.         if isTReturns and theLine <> "Returns" then
  1847.             if TReturns is null then
  1848.                 set TReturns to theLine
  1849.             else
  1850.                 set TReturns to TReturns & CRLF & theLine
  1851.             end if
  1852.         end if
  1853.         if isExample and theLine <> "Example" and \
  1854.             theLine <> "Examples" then
  1855.             if Example is null then
  1856.                 set Example to theLine
  1857.             else
  1858.                 set Example to Example & CRLF & theLine
  1859.             end if
  1860.         end if
  1861.                 set Syntax to Syntax & CRLF & theLine
  1862.             end if
  1863.         end if
  1864.         if isDescr and theLine <> "Description"
  1865.             if Descr is null then
  1866.                 set Descr to theLine
  1867.             else
  1868.                 set Descr to Descr & CRLF & theLine
  1869.             end if
  1870.         end if
  1871.         if isParameters and theLine <> "Parameters" then
  1872.             if Parameters is null then
  1873.                 set Parameters to theLine
  1874.             else
  1875.                 set Parameters to Parameters & CRLF & theLine
  1876.             end if
  1877.         end if
  1878.         if isTReturns and theLine <> "Returns" then
  1879.             if TReturns is null then
  1880.                 set TReturns to theLine
  1881.             else
  1882.                 set TReturns to TReturns & CRLF & theLine
  1883.             end if
  1884.         end if
  1885.         if isExample and theLine <> "Example" and \
  1886.             theLine <> "Examples" then
  1887.             if Example is null then
  1888.                 set Example to theLine
  1889.             else
  1890.                 set Example to Example & CRLF & theLine
  1891.             end if
  1892.         end if
  1893.         end if
  1894. buttonUp
  1895. buttonUp
  1896. Go Back
  1897. ImportFListHelp
  1898. flushComTxBuffer
  1899. flushComTxBuffer    
  1900. TBK-COMM.DLL
  1901. flushComTxBuffer(<COM number>)
  1902. Flushes out any characters in the transmit buffer for a COM port.  The characters are lost.
  1903. To declare this function, include the following statement in the linkDLL control structure:
  1904. INT flushComTxBuffer(WORD)
  1905. <COM number>is the number of the COM port you want to check, such as 1 for COM1, 2 for COM2, etc.  The maximum allowable value is 4.
  1906. 0 if failed, a positive number if successful.
  1907. get flushComTxBuffer(1) -- Flush transmit queue of COM1 
  1908. exampleHilite
  1909. ImportFListHelp
  1910. selectDBFile
  1911. checkDBIndex
  1912. getDBFieldType
  1913. getDriveList
  1914. setCurrentDirectory
  1915. readComPort
  1916. nbhK@
  1917. (;L1nb
  1918.